<!-- HTML header for doxygen 1.8.12-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pymoduleconnector: pymoduleconnector.moduleconnectorwrapper.PulseDopplerByteData Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
  <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    <!-- Platform title -->
    <div class="page-title-bar container-fluid">
      <div id="projectalign" class="row">
        <div id="projectname" class="col-sm-12">pymoduleconnector
          &#160;<span id="projectnumber">1.6.2</span>
        </div>
        <div id="projectbrief" class="col-sm-12">A Python wrapper for XeThru ModuleConnector</div>
      </div>
    </div>
    <div class="topbar">
      <div class="container">
        <div id="titlearea">
          <div class="xethru-logo">
            <img src="xethru-logo_220x55HD.png" alt="Novelda XeThru web site" id="logo-image" />
          </div>
        </div>
        <!-- end header part -->
        <!-- Generated by Doxygen 1.8.12 -->
        <!--BEGIN MAIN-NAV AND SEARCHENGINE-->
        <div id="main-nav"></div>
        <!--END MAIN-NAV AND SEARCHENGINE-->
      </div>
    </div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>pymoduleconnector</b></li><li class="navelem"><b>moduleconnectorwrapper</b></li><li class="navelem"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_pulse_doppler_byte_data.xhtml">PulseDopplerByteData</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_pulse_doppler_byte_data-members.xhtml">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">pymoduleconnector.moduleconnectorwrapper.PulseDopplerByteData Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents one half or one range bin of pulse-Doppler in byte format.  
 <a href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_pulse_doppler_byte_data.xhtml#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a65dcffb6fb21ec6afb5b22e2cb005cc2"><td class="memItemLeft" align="right" valign="top"><a id="a65dcffb6fb21ec6afb5b22e2cb005cc2"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, args)</td></tr>
<tr class="separator:a65dcffb6fb21ec6afb5b22e2cb005cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a068faac02990de06d93107943cba7e49"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_pulse_doppler_byte_data.xhtml#a068faac02990de06d93107943cba7e49">get_data</a> (self)</td></tr>
<tr class="memdesc:a068faac02990de06d93107943cba7e49"><td class="mdescLeft">&#160;</td><td class="mdescRight">get_data(PulseDopplerByteData self) -&gt; ucVector  <a href="#a068faac02990de06d93107943cba7e49">More...</a><br /></td></tr>
<tr class="separator:a068faac02990de06d93107943cba7e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6a0f4e2dabc48c3289f8a6f1ffae59cf"><td class="memItemLeft" align="right" valign="top"><a id="a6a0f4e2dabc48c3289f8a6f1ffae59cf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>this</b></td></tr>
<tr class="separator:a6a0f4e2dabc48c3289f8a6f1ffae59cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a163c7bb7ff564010fd24c2c8e01f3d86"><td class="memItemLeft" align="right" valign="top"><a id="a163c7bb7ff564010fd24c2c8e01f3d86"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>frame_counter</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_frame_counter_get, _moduleconnectorwrapper.PulseDopplerByteData_frame_counter_set)</td></tr>
<tr class="separator:a163c7bb7ff564010fd24c2c8e01f3d86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cc8e9603091facde411e5424abd89a2"><td class="memItemLeft" align="right" valign="top"><a id="a8cc8e9603091facde411e5424abd89a2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>matrix_counter</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_matrix_counter_get, _moduleconnectorwrapper.PulseDopplerByteData_matrix_counter_set)</td></tr>
<tr class="separator:a8cc8e9603091facde411e5424abd89a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab97e397f93b4c9f79903d153ad16f306"><td class="memItemLeft" align="right" valign="top"><a id="ab97e397f93b4c9f79903d153ad16f306"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>range_idx</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_range_idx_get, _moduleconnectorwrapper.PulseDopplerByteData_range_idx_set)</td></tr>
<tr class="separator:ab97e397f93b4c9f79903d153ad16f306"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a913e3a87374a550f41a3f2fdd105dcb9"><td class="memItemLeft" align="right" valign="top"><a id="a913e3a87374a550f41a3f2fdd105dcb9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>range_bins</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_range_bins_get, _moduleconnectorwrapper.PulseDopplerByteData_range_bins_set)</td></tr>
<tr class="separator:a913e3a87374a550f41a3f2fdd105dcb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aa6cf40653727ae5d3d0a570bc995af"><td class="memItemLeft" align="right" valign="top"><a id="a2aa6cf40653727ae5d3d0a570bc995af"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>frequency_count</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_frequency_count_get, _moduleconnectorwrapper.PulseDopplerByteData_frequency_count_set)</td></tr>
<tr class="separator:a2aa6cf40653727ae5d3d0a570bc995af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25572a197084cb1e21890c01ecec5d58"><td class="memItemLeft" align="right" valign="top"><a id="a25572a197084cb1e21890c01ecec5d58"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>pulsedoppler_instance</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_pulsedoppler_instance_get, _moduleconnectorwrapper.PulseDopplerByteData_pulsedoppler_instance_set)</td></tr>
<tr class="separator:a25572a197084cb1e21890c01ecec5d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17ed6aee1ea904274b137df81eda1e2a"><td class="memItemLeft" align="right" valign="top"><a id="a17ed6aee1ea904274b137df81eda1e2a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>byte_step_start</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_byte_step_start_get, _moduleconnectorwrapper.PulseDopplerByteData_byte_step_start_set)</td></tr>
<tr class="separator:a17ed6aee1ea904274b137df81eda1e2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fbbf76ee399368f6524f079049f5b7d"><td class="memItemLeft" align="right" valign="top"><a id="a4fbbf76ee399368f6524f079049f5b7d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>byte_step_size</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_byte_step_size_get, _moduleconnectorwrapper.PulseDopplerByteData_byte_step_size_set)</td></tr>
<tr class="separator:a4fbbf76ee399368f6524f079049f5b7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1df3f22ebe56f38427cfc7acd925e477"><td class="memItemLeft" align="right" valign="top"><a id="a1df3f22ebe56f38427cfc7acd925e477"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>fps</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_fps_get, _moduleconnectorwrapper.PulseDopplerByteData_fps_set)</td></tr>
<tr class="separator:a1df3f22ebe56f38427cfc7acd925e477"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6553eba13ed82937ae813cdeb0df12e6"><td class="memItemLeft" align="right" valign="top"><a id="a6553eba13ed82937ae813cdeb0df12e6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>fps_decimated</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_fps_decimated_get, _moduleconnectorwrapper.PulseDopplerByteData_fps_decimated_set)</td></tr>
<tr class="separator:a6553eba13ed82937ae813cdeb0df12e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1c6ff0d724846b0003526be770deef0"><td class="memItemLeft" align="right" valign="top"><a id="ae1c6ff0d724846b0003526be770deef0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>frequency_start</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_frequency_start_get, _moduleconnectorwrapper.PulseDopplerByteData_frequency_start_set)</td></tr>
<tr class="separator:ae1c6ff0d724846b0003526be770deef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44b7d60a644fe3ffdef8192da4345739"><td class="memItemLeft" align="right" valign="top"><a id="a44b7d60a644fe3ffdef8192da4345739"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>frequency_step</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_frequency_step_get, _moduleconnectorwrapper.PulseDopplerByteData_frequency_step_set)</td></tr>
<tr class="separator:a44b7d60a644fe3ffdef8192da4345739"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a245527017baef5b1ee121d527f55626e"><td class="memItemLeft" align="right" valign="top"><a id="a245527017baef5b1ee121d527f55626e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>range</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_range_get, _moduleconnectorwrapper.PulseDopplerByteData_range_set)</td></tr>
<tr class="separator:a245527017baef5b1ee121d527f55626e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a597e5972e73cd9c12da011cffc324e4a"><td class="memItemLeft" align="right" valign="top"><a id="a597e5972e73cd9c12da011cffc324e4a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>data</b> = _swig_property(_moduleconnectorwrapper.PulseDopplerByteData_data_get, _moduleconnectorwrapper.PulseDopplerByteData_data_set)</td></tr>
<tr class="separator:a597e5972e73cd9c12da011cffc324e4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents one half or one range bin of pulse-Doppler in byte format. </p>
<p>Python Accessing vectors directly can cause memory corruption if the parent object goes out of scope and is garbage collected. Use accessor methods for a workaround.</p>
<h2>Attributes </h2>
<ul>
<li><code>frame_counter</code> : <code>uint32_t</code> Frame counter generated from chip data rate.</li>
<li><code>matrix_counter</code> : <code>uint32_t</code> Incremental matrix counter.</li>
<li><code>range_idx</code> : <code>uint32_t</code> Range bin index of current Doppler vector.</li>
<li><code>range_bins</code> : <code>uint32_t</code> Number of total range bins in the pulse-Doppler output matrix.</li>
<li><code>frequency_count</code> : <code>uint32_t</code> Number of points in frequency axis.</li>
<li><code>pulsedoppler_instance</code> : <code>uint32_t</code> Selected pulse-Doppler type from [0..N-1] where N is number of PDs.</li>
<li><code>byte_step_start</code> : <code>float</code> Start of dB-compression range.</li>
<li><code>byte_step_size</code> : <code>float</code> Size of one step in dB.</li>
<li><code>fps</code> : <code>float</code> Output chip framerate (frames per second)</li>
<li><code>fps_decimated</code> : <code>float</code> Input FPS of this pulse-Doppler instance.</li>
<li><code>frequency_start</code> : <code>float</code> Frequency of first value.</li>
<li><code>frequency_step</code> : <code>float</code> Difference between each frequency bin.</li>
<li><code>range</code> : <code>float</code> Absolute range of current frequency array.</li>
<li><p class="startli"><code>data</code> : <code>Bytes</code> Power of pulse-Doppler bins.</p>
<p class="startli">[ float = 10^{(byte * byte_step_size + byte_step_start)/10} ]</p>
</li>
</ul>
<p>C++ includes: Data.hpp </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a068faac02990de06d93107943cba7e49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a068faac02990de06d93107943cba7e49">&sect;&nbsp;</a></span>get_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PulseDopplerByteData.get_data </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>get_data(PulseDopplerByteData self) -&gt; ucVector </p>
<p>Returns a reference to the data. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>pymoduleconnector/moduleconnectorwrapper/__init__.py</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.12-->
<!-- start footer part -->
<hr class="footer"/>
 <address class="footer">
 Copyright &copy; 2016 Novelda AS - <a href="http://www.xethru.com">www.xehtru.com</a><br />
 <small>
  Generated by &#160;<a href="http://www.doxygen.org/index.html">
  <img class="footer" src="doxygen.png" alt="doxygen"/>
  </a> 1.8.12
 </small>
 </address>
</body>
</html>
